<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_sditxss: si570drv.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_sditxss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('si570drv_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">si570drv.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains definitions for low-level driver functions for controlling the SiliconLabs Si570 clock generator as mounted on the ZCU106 demo board. </p>
<p>The user should refer to the hardware device specification for more details of the device operation.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date        Changes
</p>
<hr/>
<p>
1.00     ssh 07/05/2018   Initial release
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a9ef1d169a38da27574eb409a2c39e4bc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si570drv_8h.html#a9ef1d169a38da27574eb409a2c39e4bc">SI570_DEBUG</a>&#160;&#160;&#160;FALSE</td></tr>
<tr class="memdesc:a9ef1d169a38da27574eb409a2c39e4bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Debug output enable.  <a href="#a9ef1d169a38da27574eb409a2c39e4bc">More...</a><br/></td></tr>
<tr class="separator:a9ef1d169a38da27574eb409a2c39e4bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43c263718b91deff62ddd93694237479"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si570drv_8h.html#a43c263718b91deff62ddd93694237479">SI570_SUCCESS</a>&#160;&#160;&#160;0</td></tr>
<tr class="memdesc:a43c263718b91deff62ddd93694237479"><td class="mdescLeft">&#160;</td><td class="mdescRight">The following constants are error codes generated by the functions in this driver.  <a href="#a43c263718b91deff62ddd93694237479">More...</a><br/></td></tr>
<tr class="separator:a43c263718b91deff62ddd93694237479"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c977d089105b80401b25999319592d6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si570drv_8h.html#a4c977d089105b80401b25999319592d6">SI570_ERR_IIC</a>&#160;&#160;&#160;-1</td></tr>
<tr class="memdesc:a4c977d089105b80401b25999319592d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">IIC error occurred.  <a href="#a4c977d089105b80401b25999319592d6">More...</a><br/></td></tr>
<tr class="separator:a4c977d089105b80401b25999319592d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a470244bc4ebb540e01f90cb6b6e0e270"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si570drv_8h.html#a470244bc4ebb540e01f90cb6b6e0e270">SI570_ERR_FREQ</a>&#160;&#160;&#160;-2</td></tr>
<tr class="memdesc:a470244bc4ebb540e01f90cb6b6e0e270"><td class="mdescLeft">&#160;</td><td class="mdescRight">Could not calculate frequency setting.  <a href="#a470244bc4ebb540e01f90cb6b6e0e270">More...</a><br/></td></tr>
<tr class="separator:a470244bc4ebb540e01f90cb6b6e0e270"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3b93f5b0a7f2ddd3185c8bccac12dbb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si570drv_8h.html#aa3b93f5b0a7f2ddd3185c8bccac12dbb">SI570_ERR_PARM</a>&#160;&#160;&#160;-3</td></tr>
<tr class="memdesc:aa3b93f5b0a7f2ddd3185c8bccac12dbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invalid parameter.  <a href="#aa3b93f5b0a7f2ddd3185c8bccac12dbb">More...</a><br/></td></tr>
<tr class="separator:aa3b93f5b0a7f2ddd3185c8bccac12dbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a9ef1d169a38da27574eb409a2c39e4bc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI570_DEBUG&#160;&#160;&#160;FALSE</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Debug output enable. </p>
<p>Set to TRUE to enable debug prints, to FALSE to disable debug prints. </p>

<p>Referenced by <a class="el" href="si570drv_8c.html#a410224ed7cd70489944a0668cf3e8056">Si570_DoSettings()</a>, and <a class="el" href="xsdi__example_8c.html#aef548e0580a2fece5b5e93a1d85e2693">Si570_SetClock()</a>.</p>

</div>
</div>
<a class="anchor" id="a470244bc4ebb540e01f90cb6b6e0e270"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI570_ERR_FREQ&#160;&#160;&#160;-2</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Could not calculate frequency setting. </p>

</div>
</div>
<a class="anchor" id="a4c977d089105b80401b25999319592d6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI570_ERR_IIC&#160;&#160;&#160;-1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>IIC error occurred. </p>

<p>Referenced by <a class="el" href="si570drv_8c.html#a410224ed7cd70489944a0668cf3e8056">Si570_DoSettings()</a>.</p>

</div>
</div>
<a class="anchor" id="aa3b93f5b0a7f2ddd3185c8bccac12dbb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI570_ERR_PARM&#160;&#160;&#160;-3</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Invalid parameter. </p>

<p>Referenced by <a class="el" href="si570drv_8c.html#a410224ed7cd70489944a0668cf3e8056">Si570_DoSettings()</a>.</p>

</div>
</div>
<a class="anchor" id="a43c263718b91deff62ddd93694237479"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SI570_SUCCESS&#160;&#160;&#160;0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The following constants are error codes generated by the functions in this driver. </p>
<p>Operation was successful </p>

<p>Referenced by <a class="el" href="si570drv_8c.html#a410224ed7cd70489944a0668cf3e8056">Si570_DoSettings()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
